Request way:POST
Content-Type:application/x-www-form-urlencoded
Request address:http://customer.ydhex.com/webservice/PublicService.asmx/ServiceInterfaceUTF8
| Body parameter name | type | Mandatory | description | example |
|---|---|---|---|---|
| appToken | string | Y | API account number | |
| appKey | string | Y | API password | |
| serviceMethod | string | Y | method name | createorder |
| paramsJson | string | Y | Data content | json format |
Sample request:
| paramsJsonparameter | type | Mandatory | description |
|---|---|---|---|
| reference_no | string | Y | Customer Reference Number |
| shipping_method | string | Y | product code |
| shipping_method_no | string | tracking number | |
| order_weight | string | Service provider order number Weight (unit: KG). Default value: 0.2 | |
| order_pieces | string | Number of packages. The default value is 1 | |
| cargotype | string | type of goods W:package D:file B:bag |
|
| mail_cargo_type | string | Type of parcel declaration 1:Gift 2:CommercialSample 3:Document file 4:Other default4 |
|
| VatNum | string | UK VAT tax number | |
| IossNum | string | Eu IOSS tax code | |
| return_sign | string | Whether the returned product Mandatorys to be identified (Y,N) | |
| buyer_id | string | EORI | |
| order_info | string | order note | |
| platform_id | string | Platform ID (If you are an e-commerce platform, please contact us to add and confirm your corresponding platform ID) | |
| custom_hawbcode | string | Custom order number | |
| shipper | object | Y | Sender information |
| shipper.shipper_name | string | Y | Sender's name |
| shipper.shipper_company | string | Sender's Company | |
| shipper.shipper_countrycode | string | Y | Country code of sender |
| shipper.shipper_province | string | Sender's province | |
| shipper.shipper_city | string | Sender's City | |
| shipper.shipper_street | string | Y | Sender's address |
| shipper.shipper_postcode | string | Sender's zip code | |
| shipper.shipper_areacode | string | Sender's zip Indicates the sender area code | |
| shipper.shipper_telephone | string | Y | Sender's phone number |
| shipper.shipper_mobile | string | Sender's mobile phone | |
| shipper.shipper_email | string | Sender's email | |
| shipper.shipper_fax | string | Sender's fax | |
| consignee | object | Y | consignee information |
| consignee.consignee_name | string | Y | consignee's name |
| consignee.consignee_company | string | Consignee's Company name | |
| consignee.consignee_countrycode | string | Y | Consignee's countrycode |
| consignee.consignee_province | string | optional | Consignee's province |
| consignee.consignee_city | string | optional | Consignee's city |
| consignee.consignee_street | string | Y | Consignee's street |
| consignee.consignee_postcode | string | optional | Consignee's postcode |
| consignee.consignee_doorplate | string | consignee's house number | |
| consignee.consignee_areacode | string | Consignee's area code | |
| consignee.consignee_telephone | string | Y | consignee's phone |
| consignee.consignee_mobile | string | Consignee's mobile phone | |
| consignee.consignee_email | string | Consignee's email | |
| consignee.consignee_fax | string | Consignee's fax | |
| consignee.consignee_katakana | string | Consignee's katakana | |
| consignee.consignee_certificatetype | string | Certificate type code ID:identity card PP:passport |
|
| consignee.consignee_certificatecode | string | ID Number | |
| consignee.consignee_credentials_period | string | validity of a certificate | |
| consignee.consignee_tariff | string | optional | tax id |
| invoice | array | Y | Customs Declaration Information |
| invoice.sku | string | SKU | |
| invoice.invoice_enname | string | Y | name of commodity in English |
| invoice.invoice_cnname | string | optional | name of commodity in Chinese |
| invoice.invoice_quantity | string | Y | quantity |
| invoice.unit_code | string | unit MTR:meter PCE:piece SET:set default PCE |
|
| invoice.invoice_unitcharge | string | Y | Unit price (price of a single commodity) |
| invoice.jp_hs_code | string | japan hs code | |
| invoice.invoice_currencycode | string | Currency USD:dollar JPY:yen RMB:Ren Min Bi EUR:Euro GBP:Pound HKD:Hong Kong dollar RUB:Russian Ruble SGD:Singapore dollar default USD |
|
| invoice.hs_code | string | hs code | |
| invoice.invoice_note | string | invoice remark | |
| invoice.invoice_url | string | website | |
| invoice.invoice_info | string | invoice_info | |
| invoice.invoice_material | string | texture | |
| invoice.invoice_spec | string | specification | |
| extra_service | array | N | additional service |
| extra_service.extra_servicecode | string | Y | Additional service type code |
| extra_service.extra_servicevalue | string | optional | Additional service value (some additional service types must be passed this value) |
| extra_service.extra_servicenote | string | remark |
Return the sample:
{
"success": 1,
"cnmessage": "订单创建成功",
"enmessage": "Order created successfully",
"data": {
"order_id": 51770,
"refrence_no": "TEST2018000002",
"shipping_method_no": "RZ000013260TW",
"channel_hawbcode": ""
}
}
| parameter name | Description | type |
|---|---|---|
| success | 0 is failure. 1 is success | int |
| cnmessage | message in Chinese | string |
| enmessage | message in English | string |
| data | Response | object |
| data.order_id | orderID | string |
| data.refrence_no | shipper_hawbcode | string |
| data.shipping_method_no | tracking number | string |
| data.channel_hawbcode | channel_hawbcode | string |
Request way:POST
Content-Type:application/x-www-form-urlencoded
Request address:http://customer.ydhex.com/webservice/PublicService.asmx/ServiceInterfaceUTF8
| Body parameter name | type | Mandatory | description | example |
|---|---|---|---|---|
| appToken | string | Y | API account number | |
| appKey | string | Y | API password | |
| serviceMethod | string | Y | method name | createcommercialorder |
| paramsJson | string | Y | Data content | json format |
Sample request:
| paramsJsonparameter | type | Mandatory | description |
|---|---|---|---|
| reference_no | string | Y | Customer Reference Number |
| shipping_method | string | Y | product code |
| shipping_method_no | string | tracking number | |
| order_weight | string | Service provider order number Weight (unit: KG). Default value: 0.2 | |
| order_pieces | string | Number of packages. The default value is 1 | |
| cargotype | string | type of goods W:package D:file B:bag |
|
| mail_cargo_type | string | Type of parcel declaration 1:Gift 2:CommercialSample 3:Document file 4:Other default4 |
|
| VatNum | string | UK VAT tax number | |
| IossNum | string | Eu IOSS tax code | |
| return_sign | string | Whether the returned product Mandatorys to be identified (Y,N) | |
| buyer_id | string | EORI | |
| order_info | string | order note | |
| platform_id | string | Platform ID (If you are an e-commerce platform, please contact us to add and confirm your corresponding platform ID) | |
| custom_hawbcode | string | Custom order number | |
| shipper | object | Y | Sender information |
| shipper.shipper_name | string | Y | Sender's name |
| shipper.shipper_company | string | Sender's Company | |
| shipper.shipper_countrycode | string | Y | Country code of sender |
| shipper.shipper_province | string | Sender's province | |
| shipper.shipper_city | string | Sender's City | |
| shipper.shipper_street | string | Y | Sender's address |
| shipper.shipper_postcode | string | Sender's zip code | |
| shipper.shipper_areacode | string | Sender's zip Indicates the sender area code | |
| shipper.shipper_telephone | string | Y | Sender's phone number |
| shipper.shipper_mobile | string | Sender's mobile phone | |
| shipper.shipper_email | string | Sender's email | |
| shipper.shipper_fax | string | Sender's fax | |
| consignee | object | Y | consignee information |
| consignee.consignee_name | string | Y | consignee's name |
| consignee.consignee_company | string | Consignee's Company name | |
| consignee.consignee_countrycode | string | Y | Consignee's countrycode |
| consignee.consignee_province | string | optional | Consignee's province |
| consignee.consignee_city | string | optional | Consignee's city |
| consignee.consignee_street | string | Y | Consignee's street |
| consignee.consignee_postcode | string | optional | Consignee's postcode |
| consignee.consignee_doorplate | string | consignee's house number | |
| consignee.consignee_areacode | string | Consignee's area code | |
| consignee.consignee_telephone | string | Y | consignee's phone |
| consignee.consignee_mobile | string | Consignee's mobile phone | |
| consignee.consignee_email | string | Consignee's email | |
| consignee.consignee_fax | string | Consignee's fax | |
| consignee.consignee_katakana | string | Consignee's katakana | |
| consignee.consignee_certificatetype | string | Certificate type code ID:identity card PP:passport |
|
| consignee.consignee_certificatecode | string | ID Number | |
| consignee.consignee_credentials_period | string | validity of a certificate | |
| consignee.consignee_tariff | string | optional | tax id |
| fba_order_extend | object | Y | commercial order extended information |
| fba_order_extend.product_types_code | string | product types (multiple "," separated) | |
| fba_order_extend.delivery_method | string | delivery method A yida pickup B customer self pickup |
|
| fba_order_extend.warehousing_date | string | entry date | |
| fba_order_extend.warehousing_period | string | entry time period | |
| fba_order_extend.is_declare_customs | string | customs declaration or not Y N |
|
| fba_order_extend.declare_customs_file | string | address of customs declaration documents | |
| fba_order_extend.is_tax_inclusive | string | tax included or not Y N |
|
| fba_order_extend.delivery_terms | string | delivery terms A(DDP) B(DDU) |
|
| fba_order_extend.is_purchase_insurance | string | whether to purchase insurance Y N |
|
| fba_order_extend.purchase_insurance_amount | string | purchase insurance amount | |
| fba_order_extend.warehouse_code | string | warehouse code | |
| fba_order_extend.shipper_type | string | sender Type X-select address N-private address |
|
| fba_order_extend.consignee_type | string | recipient type X-FBA select address N-private address |
|
| fba_order_extend.freight_type | string | Y | freight payment method SENDER_PAY-payment by sender CONSIGNEE_PAY-recipient payment IMPORTER_PAY-importer payment |
| fba_order_extend.freight_type_account | string | received payment account | |
| fba_order_extend.freight_amount | string | received payment amount | |
| fba_order_extend.freight_currency | string | currency of payment upon receipt | |
| fba_order_extend.is_Degauss | string | magnetic inspection or not | |
| fba_order_extend.is_remarks | string | remarks or not | |
| fba_order_extend.tax_payment_type | string | Y | tax payment method SENDER_PAY-payment by sender CONSIGNEE_PAY-recipient payment IMPORTER_PAY-importer payment |
| fba_order_extend.tax_payment_type_account | string | tax payment method account | |
| fba_order_extend.order_type | string | order type | |
| fba_order_extend.packaging_type | string | Y | other types of goods ENV:file pocket WOOD:wooden box PAK:waterproof bag BOX:carton TARY:tray OTH:other |
| MouthSeatInfo | object | kouzuo account information | |
| MouthSeatInfo.ms_name | string | japanese importer | |
| MouthSeatInfo.ms_bankname | string | bank name | |
| MouthSeatInfo.ms_bankcode | string | bank code | |
| MouthSeatInfo.ms_branchcode | string | branch code | |
| MouthSeatInfo.account_number | string | account number | |
| invoice | array | Y | Customs Declaration Information |
| invoice.sku | string | SKU | |
| invoice.invoice_enname | string | Y | name of commodity in English |
| invoice.invoice_cnname | string | optional | name of commodity in Chinese |
| invoice.invoice_quantity | string | Y | quantity |
| invoice.unit_code | string | unit MTR:meter PCE:piece SET:set default PCE |
|
| invoice.invoice_unitcharge | string | Y | Unit price (price of a single commodity) |
| invoice.jp_hs_code | string | japan hs code | |
| invoice.invoice_currencycode | string | Currency USD:dollar JPY:yen RMB:Ren Min Bi EUR:Euro GBP:Pound HKD:Hong Kong dollar RUB:Russian Ruble SGD:Singapore dollar default USD |
|
| invoice.hs_code | string | hs code | |
| invoice.invoice_note | string | invoice remark | |
| invoice.invoice_url | string | website | |
| invoice.invoice_info | string | invoice_info | |
| invoice.invoice_material | string | texture | |
| invoice.invoice_spec | string | specification | |
| extra_service | array | N | additional service |
| extra_service.extra_servicecode | string | Y | Additional service type code |
| extra_service.extra_servicevalue | string | optional | Additional service value (some additional service types must be passed this value) |
| extra_service.extra_servicenote | string | remark |
Return the sample:
{
"success": 1,
"cnmessage": "订单创建成功",
"enmessage": "Order created successfully",
"data": {
"order_id": 51770,
"refrence_no": "TEST2018000002",
"shipping_method_no": "RZ000013260TW",
"channel_hawbcode": ""
}
}
| parameter name | Description | type |
|---|---|---|
| success | 0 is failure. 1 is success | int |
| cnmessage | message in Chinese | string |
| enmessage | message in English | string |
| data | Response | object |
| data.order_id | orderID | string |
| data.refrence_no | shipper_hawbcode | string |
| data.shipping_method_no | tracking number | string |
| data.channel_hawbcode | channel_hawbcode | string |
request method:POST
Content-Type:application/x-www-form-urlencoded
Url: http://customer.ydhex.com/webservice/PublicService.asmx/ServiceInterfaceUTF8
| Bodyparameter name | type | Mandatory | describe | example |
|---|---|---|---|---|
| appToken | string | Y | API account number | |
| appKey | string | Y | API password | |
| serviceMethod | string | Y | serviceMethod | getnewlabel |
| paramsJson | string | Y | Request | jsonformat |
requestexample:
| paramsJsonparameter | type | Mandatory | describe |
|---|---|---|---|
| configInfo | object | Y | configuration information |
| configInfo.lable_file_type | string | Y | label file type 1:PNGfile 2:PDFfile |
| configInfo.lable_paper_type | string | Y | papertype 1:labelpaper(10*10cm) 2:A4paper(21*29.7cm) |
| configInfo.lable_content_type | string | Y | label content typecode 1:label 2:customs declaration 3:manifest sheet 4:label+customs declaration 5:label+manifest sheet 6:label+customs declaration+manifest sheet |
| configInfo.additional_info | object | Y | Additional configuration messge |
| configInfo.additional_info.lable_print_invoiceinfo | string | Print distribution information on the surface sheet(Y:YES N:NO) default N:NO | |
| configInfo.additional_info.lable_print_buyerid | string | Whether to print the buyer ID on the sheet (Y:Y N:NO) default N:NO | |
| configInfo.additional_info.lable_print_datetime | string | Whether to print the date on the sheet (Y:Y N:NO) default Y:Y | |
| configInfo.additional_info.customsdeclaration_print_actualweight | string | customs declaration Whether to print the actual weight (Y:Y N:NO) default N:NO | |
| listorder | array | Y | order messge |
| listorder.reference_no | string | Y | shipper_hawbcode |
| config_code | string | The default value is 1 |
Response:
{
"success": 1,
"cnmessage": "获取订单面单成功",
"enmessage": "Get order label successfully",
"data": [
{
"lable_file_type": "2",
"lable_file": "http://customer.ydhex.com/api-lable/pdf/20180913/0fb7227a-1ff2-4e0c-bbef-ddab75d74a10.pdf"
}
]
}
| parameter name | describe | type |
|---|---|---|
| success | 0 indicates failure. 1 is success | |
| cnmessage | Chinese message | string |
| enmessage | English message | string |
| data | Response | array |
| data.lable_file_type | labelfiletype 1 :PNGfile 2 :PDFfile | string |
| data.lable_file | labelfileurl location | string |
request method:POST
Content-Type:application/x-www-form-urlencoded
Url:http://customer.ydhex.com/webservice/PublicService.asmx/ServiceInterfaceUTF8
| Bodyparameter name | type | Mandatory | describe | example |
|---|---|---|---|---|
| appToken | string | Y | API account number | |
| appKey | string | Y | API password | |
| serviceMethod | string | Y | method name | gettrack |
| paramsJson | string | Y | requestParameter data content | json format |
requestexample:
| paramsJsonparameter | type | Mandatory | describe |
|---|---|---|---|
| tracking_number | string | Y | Support service number, at the same time receive order with up to 20 service provider, separation, such as: 1 355095460000355954000. |
Return the sample:
{
"success": 1,
"cnmessage": "Get trace records成功",
"enmessage": "Get Track successfully",
"data": [
{
"tracking number": "RZ000013260TW",
"destination_country": "US",
"track_status": "NT",
"track_status_name": "转运中",
"signatory_name": "",
"details": [
{
"track_occur_date": "2018-09-04 11:52:27",
"track_location": "",
"track_description": "快件操作完成",
"track_description_en": "Shipment departed from facility",
"track_description_jp": "ショートカットの操作が完了しました"
}
]
}
]
}
| parameter name | describe | type |
|---|---|---|
| success | 0 indicates failure. 1 is success | int |
| cnmessage | Chinese message | string |
| enmessage | English message | string |
| data | Response | array |
| data.tracking number | tracking number | string |
| data.destination_country | Country Code | string |
| data.track_status | Track status code | string |
| data.track_status_name | Track status name | string |
| data.signatory_name | signatory_name | string |
| data.details | Details | array |
| data.details.track_occur_date | time | string |
| data.details.track_location | location | string |
| data.details.track_code | tracking code | string |
| data.details.track_description | tracking | string |
request method:POST
Content-Type:application/x-www-form-urlencoded
Url:http://customer.ydhex.com/webservice/PublicService.asmx/ServiceInterfaceUTF8
| Bodyparameter name | type | Mandatory | describe | example |
|---|---|---|---|---|
| appToken | string | Y | API account number | |
| appKey | string | Y | API password | |
| serviceMethod | string | Y | method name | fee trail |
| paramsJson | string | Y | requestParameter data content | jsonformat |
requestexample:
| paramsJsonparameter | type | Mandatory | describe |
|---|---|---|---|
| country_code | string | Y | Country Code |
| weight | string | Y | weight(KG) |
| shipping_method | string | Y | product code |
| post_code | string | destination postcode | |
| location | string | ||
| cargo_type | string | goods type(W:package D:file) default:W | |
| length | string | length(CM) | |
| width | string | width(CM) | |
| height | string | height(CM) | |
| extra_service | array | additional service code |
Return the sample:
{
"success": 1,
"cnmessage": "运费试算成功",
"enmessage": "fee trial successfully",
"data": [
{
"ServiceCode": "PK0033",
"ServiceCnName": "中国邮政挂号",
"ServiceEnName": "CNGH",
"ChargeWeight": "1.5",
"Effectiveness": "5-7",
"Formula": "144",
"FreightFee": "144.00",
"FuelFee": "0.00",
"RegisteredFee": "6.16",
"OtherFee": "0.00",
"OtherFeeDetails": [
],
"TotalFee": 150.16,
"ProductSort": 0,
"Remark": "中国邮政挂号",
"Traceability": "Y",
"VolumeCharge": ""
},
{
"ServiceCode": "PK0073",
"ServiceCnName": "DHL本地",
"ServiceEnName": "DHLL",
"ChargeWeight": "10.000",
"Effectiveness": "3-5",
"Formula": "(2096) * 0.8折",
"FreightFee": "1676.80",
"FuelFee": "1.34",
"RegisteredFee": "0.00",
"OtherFee": "134.28",
"OtherFeeDetails": [
{
"FeeAmount": "134.28",
"FeeCnName": "报关费",
"FeeEnName": "clearance fee"
}
],
"TotalFee": 1812.42,
"ProductSort": 0,
"Remark": "",
"Traceability": "Y",
"VolumeCharge": "5000"
}
]
}
| parameter name | describe | type |
|---|---|---|
| success | 0 is failure. 1 is success | |
| cnmessage | Chinese message | string |
| enmessage | English message | string |
| data | Response | array |
| data.ServiceCode | mode of transportationcode | string |
| data.ServiceCnName | mode of transportation Chinese name | string |
| data.ServiceEnName | mode of transportation English name | string |
| data.ChargeWeight | billing weight | string |
| data.FreightFee | freight | string |
| data.FuelFee | fuel charge | string |
| data.RegisteredFee | registration fee | string |
| data.OtherFee | other expenses | string |
| data.OtherFeeDetails | details of other expenses | array |
| data.OtherFeeDetails.FeeCnName | expenses Chinese name | string |
| data.OtherFeeDetails.FeeEnName | expenses English name | string |
| data.OtherFeeDetails.FeeAmount | shipping fee | string |
| data.TotalFee | all-in cost | string |
| data.Effectiveness | service time | string |
| data.Traceability | full track or semi track | string |
| data.VolumeCharge | volume charge | string |
| data.Formula | freight formula | string |
| data.Remark | remark | string |
request method:POST
Content-Type:application/x-www-form-urlencoded
Url:http://customer.ydhex.com/webservice/PublicService.asmx/ServiceInterfaceUTF8
| Bodyparameter name | type | Mandatory | describe | example |
|---|---|---|---|---|
| appToken | string | Y | API account number | |
| appKey | string | Y | API password | |
| serviceMethod | string | Y | method name | removeorder |
| paramsJson | string | Y | requestParameter data content | jsonformat |
requestexample:
| paramsJsonparameter | type | Mandatory | describe |
|---|---|---|---|
| reference_no | string | Y | shipper_hawbcode |
Return the sample:
{
"success": 1,
"cnmessage": "订单移除成功",
"enmessage": "Order removal succeeded"
}
| parameter name | describe | type |
|---|---|---|
| success | 0 is failure. 1 is success | |
| cnmessage | Chinese message | string |
| enmessage | English message | string |
request method:POST
Content-Type:application/x-www-form-urlencoded
Url:http://customer.ydhex.com/webservice/PublicService.asmx/ServiceInterfaceUTF8
| Bodyparameter name | type | Mandatory | describe | example |
|---|---|---|---|---|
| appToken | string | Y | API account number | |
| appKey | string | Y | API password | |
| serviceMethod | string | Y | method name | updateorder |
| paramsJson | string | Y | requestParameter data content | jsonformat |
requestexample:
| paramsJson parameter | type | Mandatory | describe |
|---|---|---|---|
| reference_no | string | Y | shipper_hawbcode |
| order_weight | string | Y | orderweight |
Return the sample:
{
"success": 1,
"cnmessage": "更新订单成功",
"enmessage": "更新订单成功"
}
| parameter name | describe | type |
|---|---|---|
| success | 0 is failure. 1 is success | |
| cnmessage | Chinese message | string |
| enmessage | English message | string |
request method:POST
Content-Type:application/x-www-form-urlencoded
Url:http://customer.ydhex.com/webservice/PublicService.asmx/ServiceInterfaceUTF8
| Bodyparameter name | type | Mandatory | describe | example |
|---|---|---|---|---|
| appToken | string | Y | API account number | |
| appKey | string | Y | API password | |
| serviceMethod | string | Y | method name | updateconsigneetariff |
| paramsJson | string | Y | requestParameter data content | jsonformat |
requestexample:
| paramsJson parameter | type | Mandatory | describe |
|---|---|---|---|
| reference_no | string | Y | shipper_hawbcode |
| consignee_tariff | string | Y | consignee tariff |
| consignee_name | string | Y | consignee name |
| phone | string | Y | consignee mobile/tel |
Return the sample:
{
"success": 1,
"cnmessage": "更新订单成功",
"enmessage": "更新订单成功"
}
| parameter name | describe | type |
|---|---|---|
| success | 0 is failure. 1 is success | |
| cnmessage | Chinese message | string |
| enmessage | English message | string |
request method:POST
Content-Type:application/x-www-form-urlencoded
Url:http://customer.ydhex.com/webservice/PublicService.asmx/ServiceInterfaceUTF8
| Bodyparameter name | type | Mandatory | describe | example |
|---|---|---|---|---|
| appToken | string | Y | API account number | |
| appKey | string | Y | API password | |
| serviceMethod | string | Y | method name | getshippingmethod:acquire mode of transportation getmailcargotype:Obtaining declaration type getcountry:Access to national getcertificatetype:Access to documents type getdeclareunit:Obtaining the reporting unit getextraservice:Obtaining additional services getlabelconfig:Get the LabelPaper configuration |
| paramsJson | string | request Parameter data content | empty |
requestexample:
Return the sample:
{
"success": 1,
"cnmessage": null,
"enmessage": null,
"data": [
{
"code": "",
"cnname": "",
"enname": "",
"note": ""
}
]
}
| parameter name | describe | type |
|---|---|---|
| success | 0 is failure. 1 is success | |
| cnmessage | Chinese message | string |
| enmessage | English message | string |
| data | Response | array |
| data.code | code | string |
| data.cnname | Chinese name | string |
| data.enname | English name | string |
| data.note | remark | string |
request method:POST
Content-Type:application/x-www-form-urlencoded
Url:http://customer.ydhex.com/webservice/PublicService.asmx/ServiceInterfaceUTF8
| Bodyparameter name | type | Mandatory | describe | example |
|---|---|---|---|---|
| appToken | string | Y | API account number | |
| appKey | string | Y | API password | |
| serviceMethod | string | Y | method name | gettrackingnumber |
| paramsJson | string | Y | requestParameter data content | jsonformat |
requestexample:
| paramsJsonparameter | type | Mandatory | describe |
|---|---|---|---|
| reference_no | string | Y | shipper_hawbcode |
Return the sample:
{
"success": 1,
"cnmessage": "获取跟踪单号成功",
"enmessage": "succeeded",
"data":
{
"refrence_no": "RZ000013260TW",
"shipping_method_no": "TEST2018000002",
"channel_hawbcode": "CHAN2018000002"
}
}
| parameter name | describe | type |
|---|---|---|
| success | 0 is failure. 1 is success | |
| cnmessage | Chinese message | string |
| enmessage | English message | string |
| data | Returned data | object |
| data.refrence_no | shipper_hawbcode | string |
| data.shipping_method_no | tracking number | string |
| data.channel_hawbcode | channel_hawbcode | string |